# VS Code插件使用教程

# **功能概述**

为方便开发者使用 [VS Code](<https://code.visualstudio.com/>) 开发UniRTOS，团队特推出UniRTOS VS Code插件。

```{image} images/image_R9xEbYoQboIMyJxnHGycbHHInae.webp
:width: 1143px
:height: 837px
:align: center
```

打开VS Code侧边栏的UniRTOS插件，主要功能如下图所示：

```{image} images/image_Pj7gbQUeeojt8PxGyLWchyj9nrf.webp
:width: 343px
:height: 390px
:align: center
```

- **New Project**：创建全新的UniRTOS项目，自动将UniRTOS SDK拉取到本地，并生成用户指定名称的项目。

- **New Project From Demo**：创建附带Demo的UniRTOS新项目，同样会自动拉取SDK，并允许在创建时选择需要引入的Demo。

- **Open Existing Project**：打开本地已有的UniRTOS项目。

- **Build**：一键编译固件，编译目标为新建项目时所选的模块型号。

- **Flash**：一键烧录固件，通过下载端口将编译好的固件烧录到目标模块。

- **Debug**：连接模块的Debug端口，实时查看模块输出的调试日志，便于程序调试。

- **Document Center**：UniRTOS官方文档中心，可直接在VS Code中打开，便于查阅API文档等资料。

- **Github**：UniRTOS官方Github仓库，可直接在VS Code中打开，便于获取官方示例代码、SDK等资源。

- **Forum**：UniRTOS官方支持社区，用于获取技术支持、交流开发经验。

- **Official Website**：UniRTOS官方网站，用于获取UniRTOS最新动态与资讯。

# 插件安装

1. 点击VS Code左侧活动栏的 **Extensions** 图标；

2. 在插件搜索框中输入 **UniRTOS**；

3. 在搜索列表中找到UniRTOS插件，点击 **Install** 按钮，完成插件安装。

```{image} images/image_Su2cbszxvoVZHdxFW8mcnb0rne8.webp
:width: 368px
:height: 233px
:align: center
```

# 插件使用方法

## 创建新项目

1. 依次点击 **UniRTOS插件** -> **Development**-> **New Project**；

```{image} images/image_Y4hAbFA6roAI2hx6khLc9pj6nff.webp
:width: 317px
:height: 306px
:align: center
```

2. 点击后，如下必填字段将显示在面板中；

```{image} images/image_MdjQbYblUo7mK9xgDOJcbjS3nef.webp
:width: 1324px
:height: 465px
```

3. 选择开发板型号（以EG800ZEU_LA为例）；

```{image} images/image_Rx57bPS92ocuzuxsBd2cVNIJnVf.webp
:width: 906px
:height: 410px
:align: center
```

4. 在 **Project name** 中输入项目名称；

```{image} images/image_UvFxb5OK6ogdX7xYYNvcqg7qnCd.webp
:width: 1098px
:height: 417px
:align: center
```

5. 选择 **Save location**，点击 **Choose** 选择保存路径；

```{image} images/image_GxfLbNPa9oPfbExovKWcODW5ntc.webp
:width: 1110px
:height: 437px
:align: center
```

6. 选择路径后，点击 **Create Project** 生成项目；

```{image} images/image_UpTVbVwJxoUXi6x8n5Xc04sinpb.webp
:width: 1106px
:height: 436px
:align: center
```

7. 右下角会显示创建进度；

```{image} images/image_GDpsbxETIo2Xz4xNZljcpKPJnke.webp
:width: 449px
:height: 80px
:align: center
```

8. 创建完成后，新项目将在VS Code中自动打开。

```{image} images/image_JCuvbhZFUoDoBaxM9mecwN5ZnTf.webp
:width: 1565px
:height: 798px
:align: center
```

## 创建Demo项目

1. 依次点击 **UniRTOS插件** -> **Development** -> **New Project From Demo**；

```{image} images/image_OGapbieD4oRr0VxYdlqct3YGnWf.webp
:width: 317px
:height: 323px
:align: center
```

2. 创建Demo项目前，可选择创建新项目或使用当前项目；

```{image} images/image_C9n2biPEKolsMMxCPgFcqbdhnIg.webp
:width: 1103px
:height: 471px
:align: center
```

3. 点击 **Demo Project**，选择要创建的项目（以 **Hello World** 为例）；

```{image} images/image_WEURbNgDnoRTo9xtBCKc1gutnUe.webp
:width: 1080px
:height: 367px
:align: center
```

4. 创建方法参见 [创建新项目](#创建新项目)；

```{image} images/image_GKonblAlXo0ieDx5IxtchtJynKg.webp
:width: 1077px
:height: 357px
:align: center
```

5. SDK和Demo项目克隆完成后，Demo项目将自动打开。

```{image} images/image_SHBKbIrbHoolsyx5y7TcptfGnz1.webp
:width: 1086px
:height: 675px
:align: center
```

## 编译固件

**前提条件**：

- 构建SDK前，请安装所有依赖项。

- 使用此功能前，请打开UniRTOS项目。

1. 依次点击 **UniRTOS插件** -> **Development** -> **Build**;

```{image} images/image_Qj10b3lTsoJPz2xd4RucLE6Yn7g.webp
:width: 323px
:height: 313px
:align: center
```

2. 此时会弹出是否构建项目的开发板型号，点击 **Yes**;

```{image} images/image_AFwDbc5VAo0HclxnskzcE5m8nNh.webp
:width: 520px
:height: 173px
:align: center
```

3. 确认后，OUTPUT窗口将显示处理过程，最后显示成功消息。

```{image} images/image_N5gUbB3NroX6nExhqKkclLvOnse.webp
:width: 1073px
:height: 826px
:align: center
```

## 烧录固件

**前提条件**：

- 构建SDK前，请安装所有依赖项。

- 使用此功能前，请打开UniRTOS项目。

1. 依次点击 **UniRTOS插件** -> **Development** -> **Flash**。

```{image} images/image_IVRtbeAPMoQdsBxLkumcxwbnnLg.webp
:width: 1131px
:height: 368px
:align: center
```

2. UniRTOS插件将自动检测端口和配置文件。也可手动查找配置文件（如 *at_command.hbinpkg*）。

```{image} images/image_Tw3Lb34auocXxZxdxYxcBVQXnFg.webp
:width: 688px
:height: 242px
:align: center
```

3. 点击 **Flash Firmware** 标签页，将打开并显示处理过程，最后显示成功消息。

```{image} images/image_Gfk7bDW2YoE2ESxxZKkcBjiznkg.webp
:width: 1102px
:height: 850px
:align: center
```

## Debug

1. 依次点击 **UniRTOS插件** -> **Development** -> **Debug**；

```{image} images/image_A5Y8blllkoD0hPxmmY4cQboYnYb.webp
:width: 302px
:height: 284px
:align: center
```

2. 点击后将显示 **SERIAL MONITOR**，可实时查看模块输出的调试日志，便于程序调试。

```{image} images/image_DOYPbht5OogTjwxT27Lck3gRnUd.webp
:width: 789px
:height: 416px
:align: center
```